responselike

What is responselike?

The `responselike` npm package is designed to create `Response` objects that mimic HTTP response objects. This can be particularly useful in testing scenarios where you want to simulate responses from web servers without making actual HTTP requests. It allows for the creation of response-like objects with properties and methods that resemble those of real HTTP responses.

What are responselike's main functionalities?

Creating a response-like object

This feature allows for the creation of a response-like object with a status code, headers, body, and URL. It's useful for simulating HTTP responses in tests.

const Response = require('responselike');
const response = new Response(200, {}, 'body', 'http://example.com');
console.log(response.statusCode); // 200

Accessing response properties

Once a response-like object is created, you can access its properties such as headers, body, and URL, similar to how you would with a real HTTP response.

console.log(response.headers); // {}
console.log(response.body); // 'body'
console.log(response.url); // 'http://example.com'

Other packages similar to responselike

nock

Nock is a powerful HTTP server mocking and expectations library for Node.js. Unlike `responselike`, which is focused on creating response-like objects, nock allows you to intercept HTTP requests and provide predefined responses. It's more comprehensive for testing HTTP interactions.

node-mocks-http

This package provides a way to mock HTTP requests and responses in Node.js, similar to `responselike`. However, `node-mocks-http` is more focused on providing a complete set of tools for mocking the `http` module, including both request and response objects, making it more suitable for integration testing.

README

responselike

A response-like object for mocking a Node.js HTTP response stream

Returns a streamable response object similar to a Node.js HTTP response stream. Useful for formatting cached responses so they can be consumed by code expecting a real response.

Install

npm install --save responselike

Or if you're just using for testing you'll want:

npm install --save-dev responselike

Usage

const Response = require('responselike');

const response = new Response(200, { foo: 'bar' }, Buffer.from('Hi!'), 'https://example.com');

response.statusCode;
// 200
response.headers;
// { foo: 'bar' }
response.body;
// <Buffer 48 69 21>
response.url;
// 'https://example.com'

response.pipe(process.stdout);
// Hi!

API

new Response(statusCode, headers, body, url)

Returns a streamable response object similar to a Node.js HTTP response stream.

statusCode

Type: number

HTTP response status code.

headers

Type: object

HTTP headers object. Keys will be automatically lowercased.

body

Type: buffer

A Buffer containing the response body. The Buffer contents will be streamable but is also exposed directly as response.body.

url

Type: string

Request URL string.

License

MIT © Luke Childs